home *** CD-ROM | disk | FTP | other *** search
/ The Utilities Experience / The Utilities Experience - Volume 1.iso / software / comms / metamail-2.3a / readme.original < prev   
Text File  |  1992-04-03  |  8KB  |  167 lines
  1. ****************************************************************
  2. Copyright (c) 1991 Bell Communications Research, Inc. (Bellcore)
  3.  
  4. Permission to use, copy, modify, and distribute this material 
  5. for any purpose and without fee is hereby granted, provided 
  6. that the above copyright notice and this permission notice 
  7. appear in all copies, and that the name of Bellcore not be 
  8. used in advertising or publicity pertaining to this 
  9. material without the specific, prior written permission 
  10. of an authorized representative of Bellcore.  BELLCORE 
  11. MAKES NO REPRESENTATIONS ABOUT THE ACCURACY OR SUITABILITY 
  12. OF THIS MATERIAL FOR ANY PURPOSE.  IT IS PROVIDED "AS IS", 
  13. WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES.
  14. ****************************************************************
  15.  
  16. I. INTRODUCTION
  17.  
  18. This is a tree of files that will build the metamail program, which can
  19. be used to turn virtually any mail-reading program into a multimedia
  20. mail reader, as well as programs that will allow metamail to display
  21. several specific types of multimedia mail.
  22.  
  23. Metamail is an implementation of MIME, the Multipurpose Internet 
  24. Mail Extensions, a proposed standard for multimedia mail on the Internet.
  25. Metamail implements MIME, and also implements extensibility and
  26. configuration via the "mailcap" mechanism described in an informational
  27. RFC that is a companion to the MIME document.
  28.  
  29. II. BUILDING METAMAIL
  30.  
  31. To compile metamail and a few useful applications, just type "make" in 
  32. the top-level directory.  Note that you may need to change the line in 
  33. the top-level Makefile that defines the ATOMICMAIL constant.  
  34. This should be the empty string if you have the metamail distribution 
  35. WITHOUT the ATOMICMAIL software, and should be set to
  36. "atomicmail" if you have the fuller, more proprietary distribution.
  37.  
  38. II.a.  SITE CONFIGURATION
  39.  
  40. There are a few things that are site-configurable before the build.
  41. If you want to check them over, look in "config.h" in the top-level 
  42. directory.  Also, if you need to change the CFLAGS Makefile variable,
  43. you can just change it in the top-level Makefile and it will propogate
  44. to the subdirectories as long as you always do a top-level make instead
  45. of cd'ing to a subdirectory and typing make.  Similarly, you can change 
  46. the LDLIBS variable in the top-level Makefile and it will be passed 
  47. down automatically.    LDLIBS may be necessary in order to get the 
  48. gethostname() call to compile, in particular.  Users of System V or
  49. other systems without symbolic links should also remove the "-s"
  50. from the definition of "LN" in the top-level Makefile.  If you're using
  51. the non-ASCII fonts from the fonts directory, and you plan to install
  52. them in a system font directory, you'll probably want to change the value
  53. for MYFONTDIR in each of the '*.source" files in the "fonts" directory.
  54.  
  55. Finally, if you have the distribution that includes the ATOMICMAIL system, 
  56. there is a file called "site.h" in the top-level ATOMICMAIL directory, in which further customization is possible.
  57.  
  58. II.b.  THE DIRECTORY STRUCTURE
  59.  
  60. Although you probably don't need to know such details, the distribution comes 
  61. with 4 or 5 source directories:  "metamail" contains the metamail
  62. program itself.  "richmail" contains the programs for dealing with
  63. email's "richtext" format.  "ezview" contains a simple program for
  64. transforming Andrew-format mail to plain text.  "fonts" contains data
  65. and scripts for display non-ASCII mail bodies, about which more is 
  66. said in a special section below.   "misc" contains a 
  67. number of shell scripts for viewing images, audio, partial messages,
  68. external messages, etc., and rudimentary shell scripts for SENDING
  69. non-text mail.  Finally, if you have the version of the distribution that
  70. includes the ATOMICMAIL software, this is contained in the
  71. "atomicmail" subdirectory.
  72.  
  73. III.  INSTALLING THE METAMAIL BINARIES
  74.  
  75. When the make is complete, you'll need to install the binaries and a 
  76. mailcap file.  For convenience, the make process will install SYMBOLIC 
  77. LINKS to all the needed binaries (or copies, in the case of shell 
  78. scripts) in the top-level "bin" directory, and man entries in the 
  79. top-level "man" directory.  You should probably copy all of these to 
  80. a more appropriate spot on your system.  
  81.  
  82. IV.  YOUR MAILCAP FILE
  83.  
  84. You'll also need to install a mailcap file.  A prototype mailcap file is 
  85. included in the top level directory, but you might want to modify it 
  86. (see metamail.1 for details about mailcap files).  
  87.  
  88. By default, the mailcap file should be installed in either /etc or 
  89. /usr/etc/ or /usr/local/etc.  However, you can easily 
  90. change this default location in the metamail source code.
  91. (This code is found in metamail/metamail.c.)
  92.  
  93. In particular, if you don't have the CMU Andrew software installed 
  94. at your site, you probably want to change the way the mailcap file 
  95. handles "text/richtext" from
  96.  
  97. text/richtext; richtoatk < %s | ezview - ; copiousoutput
  98.  
  99. to
  100.  
  101. text/richtext; richtext %s; copiousoutput
  102.  
  103. V. MODIFYING YOUR MAIL-READING PROGRAMS
  104.  
  105. The hardest part of metamail installation, by far, is the modification of 
  106. your local mail-reading programs to make them use metamail for non-text 
  107. mail.  This has been done for over a dozen of the most commonly-used 
  108. UNIX mail reading programs.  An explanation of how to modify these mail
  109. readers can be found (in various formats) in the file(s) mailers.txt.
  110.  
  111. Once you have installed all the binaries AND the modified versions of 
  112. the mail-reading programs, you should have a very extensible multimedia 
  113. mail system installed at your site.  Metamail and related software are 
  114. discussed on the INFO-METAMAIL mailing list.  If you want to sign up for this
  115. mailing list, send mail to info-metamail-request@thumper.bellcore.com.
  116. If you do not wish to join the mailing list, but you DO want to know about 
  117. future releases of metamail, please send mail indicating this interest to 
  118. Nathaniel Borenstein <nsb@bellcore.com>
  119.  
  120. VI.  The "fonts" directory.
  121.  
  122. The fonts directory contains software for non-ASCII mail.  It initially only
  123. supports ISO-8859-8 (Hebrew) and an alias for a fairly common Adobe
  124. font that supports ISO-8859-1 (W. Europe), but also provides a template for
  125. how other character sets can be supported, given the right fonts.  NOTE THAT
  126.  IF YOU DO NOT USE X11 THE "fonts" DIRECTORY IS USELESS, AND 
  127. THAT IF YOU DO NOT HAVE "bdftosnf" INSTALLED THE BUILD
  128. MAY FAIL IN THE FONTS DIRECTORY.  FOR NON-X SITES, IF
  129. YOU GET RID OF ANY REFERENCE TO IT IN THE TOP LEVEL 
  130. MAKEFILE, IT WILL NEVER GET IN YOUR WAY. 
  131.  
  132. Note also that the "fonts" directory builds but does not install the snf, 
  133. fonts.alias, and fonts.dir files.  It builds a fe scripts that make
  134. reference the build directory.  If you are installing things elsewhere,
  135. you will need to change the path reference in the "*.source" scripts
  136. (the MYFONTDIR variable) if you want non-ASCII mail to work properly.
  137.  
  138. VII.  FUTURE VERSIONS OF METAMAIL
  139.  
  140. The metamail software is being given away freely by Bellcore in the
  141. interest of promoting a wide user community for the emerging
  142. Interent standards for multimedia mail.  The metamail software is by
  143. no means a finished product, nor is it as polished as software
  144. produced for commercial purposes.  It is our hope that users will
  145. be tolerant of any warts they may find, and will contribute their
  146. own improvements, via the INFO-METAMAIL mailing list, for incorporation
  147. into future releases of the metamail software.
  148.  
  149. VIII.  TESTING METAMAIL & MIME SUPPORT
  150.  
  151. If you want a set of test messages in MIME format, exercising various 
  152. features of mtamail and MIME, you may ftp them from thumper.bellcore.com,
  153. where there is a directory called "pub/nsb/samples".  Each file in
  154. that directory is a separate MIME-compliant message which should
  155. do something interesting if viewed with a metamail-modified mail-reader.
  156.  
  157. IX.  FURTHER DOCUMENTATION
  158.  
  159. Drafts of the MIME and mailcap documents are available in the
  160. pub/nsb directory on thumper.bellcore.com.  Other documents may also
  161. become available from time to time in that directory -- feel free to 
  162. browse.
  163.  
  164. The anonymous ftp directory from thumper is mirrored for the
  165. Scandinavian countries on  ftp.funet.fi, where it can be found in
  166.  /pub/unix/mail/metamail/-
  167.